<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FabGL: VGATextController Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FabGL
   </div>
   <div id="projectbrief">ESP32 Display Controller and Graphics Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classfabgl_1_1_v_g_a_text_controller.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfabgl_1_1_v_g_a_text_controller-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">VGATextController Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Represents the VGA text-only controller.  
 <a href="classfabgl_1_1_v_g_a_text_controller.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="vgatextcontroller_8h_source.html">vgatextcontroller.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VGATextController:</div>
<div class="dyncontent">
<div class="center"><img src="classfabgl_1_1_v_g_a_text_controller__inherit__graph.png" border="0" usemap="#a_v_g_a_text_controller_inherit__map" alt="Inheritance graph"/></div>
<map name="a_v_g_a_text_controller_inherit__map" id="a_v_g_a_text_controller_inherit__map">
<area shape="rect" title="Represents the VGA text&#45;only controller." alt="" coords="22,155,153,181"/>
<area shape="rect" href="classfabgl_1_1_textual_display_controller.html" title="Represents the base abstract class for textual display controllers." alt="" coords="5,80,169,107"/>
<area shape="rect" href="classfabgl_1_1_base_display_controller.html" title="Represents the base abstract class for all display controllers." alt="" coords="11,5,163,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a93fe2c22583c485ebf4f60081f535cf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a93fe2c22583c485ebf4f60081f535cf8.html#a93fe2c22583c485ebf4f60081f535cf8">adjustMapSize</a> (int *columns, int *rows)</td></tr>
<tr class="memdesc:a93fe2c22583c485ebf4f60081f535cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts columns and rows to the controller limits.  <a href="classfabgl_1_1_v_g_a_text_controller_a93fe2c22583c485ebf4f60081f535cf8.html#a93fe2c22583c485ebf4f60081f535cf8">More...</a><br /></td></tr>
<tr class="separator:a93fe2c22583c485ebf4f60081f535cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0bdf5cca484fb2ba637c39384b27fb2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_ab0bdf5cca484fb2ba637c39384b27fb2.html#ab0bdf5cca484fb2ba637c39384b27fb2">begin</a> ()</td></tr>
<tr class="memdesc:ab0bdf5cca484fb2ba637c39384b27fb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the 64 colors (8 GPIOs) initializer using default pinout.  <a href="classfabgl_1_1_v_g_a_text_controller_ab0bdf5cca484fb2ba637c39384b27fb2.html#ab0bdf5cca484fb2ba637c39384b27fb2">More...</a><br /></td></tr>
<tr class="separator:ab0bdf5cca484fb2ba637c39384b27fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada2833a4d6b69eb90c28a273438735d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_ada2833a4d6b69eb90c28a273438735d6.html#ada2833a4d6b69eb90c28a273438735d6">begin</a> (gpio_num_t red1GPIO, gpio_num_t red0GPIO, gpio_num_t green1GPIO, gpio_num_t green0GPIO, gpio_num_t blue1GPIO, gpio_num_t blue0GPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO)</td></tr>
<tr class="memdesc:ada2833a4d6b69eb90c28a273438735d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the 64 colors (8 GPIOs) initializer.  <a href="classfabgl_1_1_v_g_a_text_controller_ada2833a4d6b69eb90c28a273438735d6.html#ada2833a4d6b69eb90c28a273438735d6">More...</a><br /></td></tr>
<tr class="separator:ada2833a4d6b69eb90c28a273438735d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a406a206bc0e13ee2a48591fcfdae6e22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a406a206bc0e13ee2a48591fcfdae6e22.html#a406a206bc0e13ee2a48591fcfdae6e22">begin</a> (gpio_num_t redGPIO, gpio_num_t greenGPIO, gpio_num_t blueGPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO)</td></tr>
<tr class="memdesc:a406a206bc0e13ee2a48591fcfdae6e22"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the 8 colors (5 GPIOs) initializer.  <a href="classfabgl_1_1_v_g_a_text_controller_a406a206bc0e13ee2a48591fcfdae6e22.html#a406a206bc0e13ee2a48591fcfdae6e22">More...</a><br /></td></tr>
<tr class="separator:a406a206bc0e13ee2a48591fcfdae6e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe93a7b8c83c1fc72de32c202dc381a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a4fe93a7b8c83c1fc72de32c202dc381a.html#a4fe93a7b8c83c1fc72de32c202dc381a">colorsCount</a> ()</td></tr>
<tr class="memdesc:a4fe93a7b8c83c1fc72de32c202dc381a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines number of colors this display can provide.  <a href="classfabgl_1_1_v_g_a_text_controller_a4fe93a7b8c83c1fc72de32c202dc381a.html#a4fe93a7b8c83c1fc72de32c202dc381a">More...</a><br /></td></tr>
<tr class="separator:a4fe93a7b8c83c1fc72de32c202dc381a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2337a67770ebd18e0ced22ba40d79d24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enumerations_gadb8147abda8588ce7306a700532148e1.html#gadb8147abda8588ce7306a700532148e1">DisplayControllerType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_textual_display_controller_a2337a67770ebd18e0ced22ba40d79d24.html#a2337a67770ebd18e0ced22ba40d79d24">controllerType</a> ()</td></tr>
<tr class="memdesc:a2337a67770ebd18e0ced22ba40d79d24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the display controller type.  <a href="classfabgl_1_1_textual_display_controller_a2337a67770ebd18e0ced22ba40d79d24.html#a2337a67770ebd18e0ced22ba40d79d24">More...</a><br /></td></tr>
<tr class="separator:a2337a67770ebd18e0ced22ba40d79d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0872427e4a351bb3590e8d00096e9cba"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_base_display_controller_a0872427e4a351bb3590e8d00096e9cba.html#a0872427e4a351bb3590e8d00096e9cba">getScreenHeight</a> ()</td></tr>
<tr class="memdesc:a0872427e4a351bb3590e8d00096e9cba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the screen height in pixels.  <a href="classfabgl_1_1_base_display_controller_a0872427e4a351bb3590e8d00096e9cba.html#a0872427e4a351bb3590e8d00096e9cba">More...</a><br /></td></tr>
<tr class="separator:a0872427e4a351bb3590e8d00096e9cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a749df909b39fd096bf6e2813f2f5324c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_base_display_controller_a749df909b39fd096bf6e2813f2f5324c.html#a749df909b39fd096bf6e2813f2f5324c">getScreenWidth</a> ()</td></tr>
<tr class="memdesc:a749df909b39fd096bf6e2813f2f5324c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the screen width in pixels.  <a href="classfabgl_1_1_base_display_controller_a749df909b39fd096bf6e2813f2f5324c.html#a749df909b39fd096bf6e2813f2f5324c">More...</a><br /></td></tr>
<tr class="separator:a749df909b39fd096bf6e2813f2f5324c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5308b6853d3778845649f08832e96535"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_base_display_controller_a5308b6853d3778845649f08832e96535.html#a5308b6853d3778845649f08832e96535">getViewPortHeight</a> ()</td></tr>
<tr class="memdesc:a5308b6853d3778845649f08832e96535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines vertical size of the viewport.  <a href="classfabgl_1_1_base_display_controller_a5308b6853d3778845649f08832e96535.html#a5308b6853d3778845649f08832e96535">More...</a><br /></td></tr>
<tr class="separator:a5308b6853d3778845649f08832e96535"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69dd55b31e9c284aeec6f2b91a8da525"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_base_display_controller_a69dd55b31e9c284aeec6f2b91a8da525.html#a69dd55b31e9c284aeec6f2b91a8da525">getViewPortWidth</a> ()</td></tr>
<tr class="memdesc:a69dd55b31e9c284aeec6f2b91a8da525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines horizontal size of the viewport.  <a href="classfabgl_1_1_base_display_controller_a69dd55b31e9c284aeec6f2b91a8da525.html#a69dd55b31e9c284aeec6f2b91a8da525">More...</a><br /></td></tr>
<tr class="separator:a69dd55b31e9c284aeec6f2b91a8da525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ea5f9decd46d4b507c65a65f9188b0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a8ea5f9decd46d4b507c65a65f9188b0b.html#a8ea5f9decd46d4b507c65a65f9188b0b">setFont</a> (FontInfo const *value)</td></tr>
<tr class="memdesc:a8ea5f9decd46d4b507c65a65f9188b0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets font.  <a href="classfabgl_1_1_v_g_a_text_controller_a8ea5f9decd46d4b507c65a65f9188b0b.html#a8ea5f9decd46d4b507c65a65f9188b0b">More...</a><br /></td></tr>
<tr class="separator:a8ea5f9decd46d4b507c65a65f9188b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4583a73c34544a3ab09802f045c16664"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a4583a73c34544a3ab09802f045c16664.html#a4583a73c34544a3ab09802f045c16664">setResolution</a> (char const *modeline=nullptr, int viewPortWidth=-1, int viewPortHeight=-1, bool doubleBuffered=false)</td></tr>
<tr class="memdesc:a4583a73c34544a3ab09802f045c16664"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets fixed resolution.  <a href="classfabgl_1_1_v_g_a_text_controller_a4583a73c34544a3ab09802f045c16664.html#a4583a73c34544a3ab09802f045c16664">More...</a><br /></td></tr>
<tr class="separator:a4583a73c34544a3ab09802f045c16664"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6935cf763d0d228200f61930f2141095"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_v_g_a_text_controller_a6935cf763d0d228200f61930f2141095.html#a6935cf763d0d228200f61930f2141095">setTextMap</a> (uint32_t const *map, int rows)</td></tr>
<tr class="memdesc:a6935cf763d0d228200f61930f2141095"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets text map to display.  <a href="classfabgl_1_1_v_g_a_text_controller_a6935cf763d0d228200f61930f2141095.html#a6935cf763d0d228200f61930f2141095">More...</a><br /></td></tr>
<tr class="separator:a6935cf763d0d228200f61930f2141095"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Represents the VGA text-only controller. </p>
<p >The text only VGA controller allows only text, but requires less than 50K of RAM. Resolution is fixed at 640x480, with 80 columns by a selectable number of rows, 16 colors.</p>
<p >Text only output is very CPU intensive process and consumes up to 30% of one CPU core. Anyway this allows to have more than 290K free for your application.</p>
<p >Graphics (<a class="el" href="classfabgl_1_1_canvas.html" title="A class with a set of drawing methods.">Canvas</a>) aren't possible. Also, some character styles aren't also possible (double size, 132 columns, italic).</p>
<p >This example initializes VGA Text Controller with 64 colors (16 usable): </p><pre class="fragment">fabgl::VGATextController VGAController;
// the default assigns GPIO22 and GPIO21 to Red, GPIO19 and GPIO18 to Green, GPIO5 and GPIO4 to Blue, GPIO23 to HSync and GPIO15 to VSync
VGAController.begin();
VGAController.setResolution();
</pre> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_others_2_keyboard_scan_codes_2_keyboard_scan_codes_8ino-example.html#_a0">Others/KeyboardScanCodes/KeyboardScanCodes.ino</a>, <a class="el" href="_v_g_a_2_altair8800_2_altair8800_8ino-example.html#_a6">VGA/Altair8800/Altair8800.ino</a>, <a class="el" href="_v_g_a_2_loopback_terminal_2_loopback_terminal_8ino-example.html#_a0">VGA/LoopbackTerminal/LoopbackTerminal.ino</a>, <a class="el" href="_v_g_a_2_network_terminal_2_network_terminal_8ino-example.html#_a0">VGA/NetworkTerminal/NetworkTerminal.ino</a>, and <a class="el" href="_v_g_a_2_simple_text_terminal_out_2_simple_text_terminal_out_8ino-example.html#_a0">VGA/SimpleTextTerminalOut/SimpleTextTerminalOut.ino</a>.</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="vgatextcontroller_8h_source.html#l00079">79</a> of file <a class="el" href="vgatextcontroller_8h_source.html">vgatextcontroller.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="vgatextcontroller_8h_source.html">vgatextcontroller.h</a></li>
<li><a class="el" href="vgatextcontroller_8cpp_source.html">vgatextcontroller.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>fabgl</b></li><li class="navelem"><a class="el" href="classfabgl_1_1_v_g_a_text_controller.html">VGATextController</a></li>
    <li class="footer">Generated on Mon Aug 29 2022 13:52:07 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
  </ul>
</div>
</body>
</html>
